home *** CD-ROM | disk | FTP | other *** search
/ Just Call Me Internet / Just Call Me Internet.iso / com / bbs / protocol / ckermit / ckaaaa.hlp next >
Text File  |  1993-11-01  |  14KB  |  340 lines
  1. CKAAAA.HLP                                                    November 23, 1992
  2.  
  3. C-Kermit 5A bears the following copyright notice:
  4.  
  5.   Copyright (C) 1985, 1992, Trustees of Columbia University in the City of
  6.   New York.  Permission is granted to any individual or institution to use
  7.   this software as long as it is not sold for profit.  This copyright notice
  8.   must be retained.  This software may not be included in commercial
  9.   products without written permission of Columbia University.
  10.  
  11. And the following disclaimer:
  12.  
  13.   The C-Kermit software is provided in source code form by Kermit Development
  14.   and Distribution, Columbia University.  The software is provided "as is;" no
  15.   other warranty is provided, express or implied, including without
  16.   limitations, any implied warranty of merchantability or implied warranty of
  17.   fitness for a particular purpose.
  18.  
  19.   Neither Columbia University nor any of the contributors to the C-Kermit
  20.   development effort, including, but not limited to, AT&T, Digital Equipment
  21.   Corporation, Data General Corporation, or International Business Machines
  22.   Corporation, warrant C-Kermit software or documentation in any way.  In
  23.   addition, neither the authors of any Kermit programs, publications or
  24.   documentation, nor Columbia University nor any contributing institutions or
  25.   individuals acknowledge any liability resulting from program or
  26.   documentation errors.
  27.  
  28. DOCUMENTATION
  29.  
  30. C-Kermit 5A is documented in the book "Using C-Kermit" by Frank da Cruz
  31. and Christine M. Gianone, Digital Press, Burlington, MA, USA.  Digital
  32. Press ISBN: 1-55558-108-0; Prentice-Hall ISBN: 0-13-037490-3.  Price: US
  33. $34.95.  In USA, call DECdirect at 1-800-344-4825, refer to order number
  34. EY-J896E-DP.  Available: January 1993.
  35.  
  36.  
  37.         GUIDE TO C-KERMIT 5A FILES AND FILE NAMING CONVENTIONS
  38.  
  39. C-Kermit is a family of Kermit programs for many different computer systems.
  40. The program shares a common set of system-independent file transfer protocol
  41. modules, written in the C language.  System-dependent operations are collected
  42. into system-specific modules for each system, or in some cases, selected via
  43. conditional compilation (#ifdef) in the UNIX system dependent modules.
  44.  
  45. C-Kermit may be built for UNIX (BSD, AT&T, Ultrix, SUNOS, Xenix, many others),
  46. DEC VMS and OpenVMS on VAX and AXP computers, Data General AOS/VS, IBM OS/2,
  47. the Apple Macintosh, the Commodore Amiga, the Atari ST, and Motorola 680x0
  48. computers with Microware OS/9.
  49.  
  50. C-Kermit file names are of the form:
  51.  
  52.   CK<system><what>.<type>
  53.  
  54. where:
  55.  
  56. <type> is the file type (use lowercase on UNIX):
  57.  
  58.   C:   C language source
  59.   H:   Header file for C language source
  60.   W:   Wart preprocessor source, converted by Wart (or Lex) to a C program
  61.   R:   Macintosh resource file (8-bit text)
  62.   A:   Assembler source
  63.  
  64.   ANN: The text of an announcement of a particular version
  65.   DOC: Documentation
  66.   HLP: Help text
  67.   NR:  Nroff/Troff text formatter source for UNIX "man page"
  68.   UPD: Program update history
  69.   BWR: A "beware" file - list of known bugs, limitations
  70.   MSS: Scribe text formatter source
  71.   PS:  Typeset material to be printed on a PostScript printer
  72.  
  73.   INI: Initialization file
  74.   TAK: A Kermit TAKE command file
  75.   KDD: A Kermit Dialing Directory
  76.   KSD: A Kermit Services Directory
  77.   TXT: A plain-text file
  78.  
  79.   MAK: A Makefile or other build procedure (often needs renaming)
  80.   COM: (VMS only) a DCL command procedure
  81.   REL: (VMS only) a RELEASE_NOTES file
  82.  
  83.   BOO: "boo"-encoded executable program, decode with CKBUNB program.
  84.   HEX: "hex"-encoded executable program, decode with CKVDEH program (VMS only).
  85.   HQX: BinHex'd Macintosh Kermit program, decode with BinHex version 4.0.
  86.   UUE: A uuencoded binary file, decode with uudecode or (DG only) CKDECO.
  87.  
  88.   DEF: An OS/2 linker definitions file.
  89.   SED: A UNIX sed (editor) script.
  90.   STR: A file of character strings extracted from C-Kermit (BSD 2.1x).
  91.  
  92. <system> is a single character to tell what system the file applies to:
  93.  
  94.   A: General descriptive material and documentation
  95.   B: BOO file encoders and decoders
  96.   C: All systems with C compilers
  97.   D: Data General AOS/VS
  98.   E: Reserved for "ckermit" files, like CKERMIT.INI
  99.   F: Microsoft Windows 3.x (F = Fenster) (reserved)
  100.   H: Harris computers, VOS (reserved)
  101.   I: Commodore Amiga (Intuition)
  102.   J: (unused)
  103.   K: (unused)
  104.   L: (unused)
  105.   M: Macintosh with Mac OS
  106.   N: Microsoft Windows NT (reserved)
  107.   O: OS/2
  108.   P: IBM PC, PS/2 with MS/PC-DOS (reserved)
  109.   Q: (unused)
  110.   R: DEC PDP-11 with RSTS/E (reserved)
  111.   S: Atari ST GEMDOS
  112.   T: DEC PDP-11 with RT-11 (reserved)
  113.   U: UNIX or environments with UNIX-like C libraries
  114.   V: VMS and OpenVMS
  115.   W: Wart (used with all systems)
  116.   X: DEC PDP-11 with RSX-11 (reserved)
  117.   Y: (unused)
  118.   Z: (unused)
  119.   0-8: (unused)
  120.   9: Microware OS-9
  121.  
  122. <what> is mnemonic (up to 3 characters) for what's in the file:
  123.  
  124.   AAA: A "read-me" file, like this one
  125.   INS: Installation instructions
  126.   KER: General C-Kermit definitions, information, documentation
  127.  
  128.   CMD: Command parsing
  129.   CON: CONNECT command
  130.   DEB: Debug/Transaction Log formats, Typedefs
  131.   DIA: Modem/Dialer control
  132.   FIO: System-depdendent File I/O
  133.   FNS: Protocol support functions
  134.   FN2: More protocol support functions (and FN3, ...)
  135.   MAI: Main program
  136.   PRO: Protocol
  137.   SCR: SCRIPT command
  138.   TIO: System-dependent communications i/o & control and interrupt handing
  139.   USR: User interface
  140.   US2: More user interface
  141.   US3: Still more user interface (and usr4, usr5, usr6, ...)
  142.   USX: Common user interface functions
  143.   USY: Command-line parsing
  144.   XLA: Character set translation module
  145.   NET: Network support module
  146.   MDB: Malloc-debugging module
  147.   STR: Strings module
  148.  
  149. Examples (use lowercase on UNIX):
  150.  
  151.   CKAAAA.HLP - This file
  152.   CKUFIO.C   - File i/o for UNIX
  153.   CKSTIO.C   - Communications i/o for the Atari ST
  154.   CKUKER.NR  - Nroff source file for UNIX C-Kermit man page
  155.   CKUKER.MAK - Makefile for building UNIX C-Kermit
  156.   CKOKER.MAK - Makefile for building OS/2 C-Kermit
  157.  
  158. IMPORTANT FILES (use lowercase names on UNIX):
  159.  
  160.   CKAAAA.HLP - This file (overview of other files).
  161.  
  162.   CKCKER.ANN - Brief list of new features of 5A (release announcements).
  163.   CKCKER.BWR - "Beware" file (limitations, known bugs, hints), general.
  164.   CKCCFG.DOC - Configuration information (feature selection), general.
  165.   CKCPLM.DOC - Program logic manual (for programmers)
  166.  
  167.   CKERMIT.INI - Standard initialization file (rename to .kermrc in UNIX, OS-9)
  168.   CKERMOD.INI - Sample customization file (rename to .mykermrc in UNIX, OS-9)
  169.   CKERMIT.KDD - Sample dialing directory file (rename to .kdd in UNIX, OS-9)
  170.   CKERMIT.KSD - Sample services directory file (rename to .ksd in UNIX, OS-9)
  171.   CKEDEMO.INI - Demonstration macros from "Using C-Kermit"
  172.   CKEVT.INI   - Ditto
  173.   CKETEST.INI - Ditto
  174.  
  175.   CKCKER.UPD - Program update history, edits 188-present
  176.   CKC188.UPD - Program update history, edits 179-188 (big)
  177.   CKC178.UPD - Program edit history, 5A edits through 178 (very big)
  178.   CKCV4F.UPD - Program edit history, version 4F
  179.   CKCV4E.UPD - Program edit history, version 4E
  180.  
  181.   CKUKER.DOC - Preliminary C-Kermit User Guide thru edit 179 (ASCII text)
  182.   CKUKER.PS  - User Guide (Postscript)
  183.  
  184.   CKUINS.DOC - UNIX-specific installation instructions
  185.   CKUKER.MAK - UNIX build procedure
  186.   CKUBS2.MAK - 2.10/2.11BSD build procedure
  187.   CKUKER.BWR - UNIX-specific beware file.
  188.   CKUKER.NR  - "man page" for UNIX
  189.  
  190.   CKVINS.DOC - VMS-specific installation instructions.
  191.   CKVKER.COM - VMS build procedure (DCL)
  192.   CKVKER.MAK - VMS build procedure (MAKE)
  193.   CKVKER.MMS - VMS build procedure (MMS)
  194.   CKVMSI.COM - VMSINSTAL-kit builder
  195.   CKVKIT.COM - VMSINSTAL-kit installer
  196.   CKVKER.BWR - VMS-specific beware file
  197.   CKVKER.HLP - VMS C-Kermit HELP topic
  198.  
  199.   CKOKER.BWR - OS/2 "beware" file
  200.   CKOICON.BOO - BOO-encoded OS/2 C-Kermit icon
  201.  
  202.   CKDINS.DOC - Data General AOS/VS C-Kermit installation instructions
  203.   CKDKER.BWR - AOS/VS "beware" file
  204.  
  205. BINARIES
  206.  
  207. If you have FTP access to watsun.cc.columbia.edu (also known as
  208. kermit.cc.columbia.edu, ftp.cc.columbia.edu, kermit.columbia.edu, or
  209. ftp.columbia.edu), you can also retrieve various C-Kermit binaries from the
  210. directory kermit/bin/ck*.*.  Be sure to transfer these files in binary mode.
  211.  
  212. ENCODED BINARIES
  213.  
  214. VMS:
  215.  CKVKER.HEX - VAX/VMS (OpenVMS) 5.5, no networks.  Decode with CKVDEH.MAR.
  216.  CKVAXP.HEX - OpenVMS AXP 1.0, no networks.  Decode (on VAX) with CKVDEH.MAR.
  217. OS-9:
  218.  CK9KER.BOO - OS-9/68000.  Decode with CKBUNB.C.
  219. OS/2:
  220.  CKOKER32.BOO - OS/2 2.00 (32-bit).  Decode with CKBUNB.C.
  221.  CKOKER16.BOO - OS/2 1.xx (16-bit).  Decode with CKBUNB.C.
  222. Amiga:
  223.  CKIKER.BOO.  Decode with CKBUNB.C.
  224. Atari ST:
  225.  CKSKER.BOO.  Decode with CKBUNB.C.
  226. Data General MV AOS/VS:
  227.  CKDKER.UUE.  Decode with uudecode or ckdeco.c, then unpack with DUMPFILE.
  228.  
  229. SOURCE FILES
  230.  
  231. All the files necessary to build a particular implementation of C-Kermit
  232. are listed in the appropriate makefile or equivalent:
  233.  
  234.        UNIX: ckuker.mak (rename to makefile)
  235.    2.11 BSD: ckubs2.mak (rename to makefile), ckustr.sed
  236.   Macintosh: ckmker.mak (rename to kermit.make, use MPW C 3.2)
  237.     VAX/VMS: CKVKER.COM (DCL), CKVKER.MAK (MAKE), or CKVKER.MMS (MMS)
  238.       Amiga: CKIKER.MAK
  239.    Atari ST: CKSKER.MAK
  240.        OS/2: CKOKER.MAK, CKOKER.DEF, CKWART.DEF (MSC 6.0, GCC, or IBM C Set/2)
  241.        OS-9: CK9KER.MAK or CK9KER.GCC
  242.      AOS/VS: CKDMAK.CLI, CKDCC.CLI, CKDLNK.CLI
  243.  
  244. Minimal source files for building selected versions (these patterns get all
  245. the files you need, and in some cases maybe a few extra):
  246.  
  247.    UNIX:   ck[cuw]*.[cwh]
  248.    VMS:    ck[cuwv]*.[cwh]
  249.    Mac:    ck[cuwm]*.[cwhr]
  250.    OS/2:   ck[cuwo]*.[cwh]
  251.    AOS/VS: ck[cuwd]*.[cwh]
  252.    Amiga:  ck[cuwi]*.[cwh]
  253.    Atari:  ck[cuws]*.[cwh]
  254.    OS-9:   ck[cwh9]*.[cawh]
  255.  
  256. Here is the specific source file list for edit 5A(188).  If C-Kermit's
  257. SHOW VERSIONS command displays higher version numbers that the ones shown
  258. here, consult the file CKCKER.UPD to find out what changes were made since
  259. the edit 188 release.
  260.  
  261. FILE      LAST EDIT    VERSION    COMMENTS
  262.  
  263. ckcasc.h  19 May 92               ASCII character symbol definitions
  264. ckcdeb.h   6 Nov 92               Definitions used by all modules
  265. ckcker.h  23 Nov 92               Kermit-specific definitions
  266. ckcsym.h  19 May 92               C preprocessor symbol definitions
  267. ckcxla.h   4 Aug 92               Common character-set translation definitions
  268. ckuver.h  18 Nov 92               Version header definitions
  269.  
  270. ckcmai.c  23 Nov 92    5A(188)    Main program
  271. ckcpro.w  23 Nov 92    5A(052)    Protocol state switcher, "wart" language
  272. ckwart.c  14 Jan 92    2A(009)    wart preprocessor for ckcpro.w
  273. ckcpro.c  23 Nov 92    5A(052)    C-language protocol state switcher
  274. ckcfns.c  24 Nov 92    5A(080)    System-independent protocol functions
  275. ckcfn2.c  23 Nov 92                ...continued
  276. ckcfn3.c  12 Oct 92                ...continued
  277. ckcnet.h  13 Oct 92               Common network support definitions
  278. ckcnet.c  23 Nov 92    5A(015)    Network support
  279.  
  280. ckcmdb.c  10 Nov 92       -       malloc()-debugging package
  281.  
  282. ckucmd.h  21 Nov 92               Interactive command parser symbols
  283. ckucmd.c  22 Nov 92    5A(053)    Interactive command parser functions
  284. ckuusr.h  26 Oct 92               User interface symbols
  285. ckuusr.c  23 Nov 92    5A(092)    Interactive command parser
  286. ckuus2.c  23 Nov 92                 ...continued
  287. ckuus3.c  21 Nov 92                 ...continued
  288. ckuus4.c  22 Nov 92                 ...continued
  289. ckuus5.c  23 Nov 92                 ...continued
  290. ckuus6.c  23 Nov 92                 ...continued
  291. ckuus7.c  23 Nov 92                 ...continued
  292. ckuusx.c  23 Nov 92               User interface common routines
  293. ckuusy.c  18 Nov 92               Command-line option parser
  294.  
  295. ckudia.c   2 Nov 92    5A(046)    DIAL command
  296. ckuscr.c   2 Nov 92    5A(015)    SCRIPT command
  297.  
  298. ck9con.c  12 Oct 92    5A(06)     OS-9 CONNECT command
  299. ck9fio.c  10 Jul 92    5A(07)     OS-9 file system interface
  300. ck9tio.c  12 Oct 92    5A(08)     OS-9 communications i/o
  301.  
  302. ckdcon.c  10 Oct 92    5A(44)     AOS/VS CONNECT command
  303. ckdfio.c  10 Oct 92    5A(064)    AOS/VS file system support
  304. ckdtio.c  10 Oct 92    5A(096)    AOS/VS communications i/o
  305.  
  306. ckicon.c   1 Sep 92    1.3        Amiga CONNECT command
  307. ckifio.c   1 Sep 92    1.6        Amiga file system support
  308. ckistu.c   1 Sep 92    1.5        Amiga stub routines
  309. ckitio.c   1 Sep 92    1.7        Amiga communications i/o
  310. ckiutl.c   1 Sep 92    1.7        Amiga utility functions
  311.  
  312. ckocon.c  25 Oct 92     -         OS/2 CONNECT command
  313. ckodir.h  20 Jan 92               OS/2 file system definitions
  314. ckoker.h   6 Nov 92               OS/2 compilation definitions
  315. ckolat.h  11 Jul 92               OS/2 LAT support definitions
  316. ckonet.c   8 Aug 92    5A(008)    OS/2 network support
  317. ckotio.c  16 Nov 92     -         OS/2 communications i/o
  318.  
  319. ckscon.c  20 Jul 92    5A(031)    Atari ST CONNECT command
  320. cksfio.c  20 Jul 92    5A(059)    Atari ST file system interface
  321. ckstio.c  20 Jul 92    5A(086)    Atari ST file communications i/o
  322.  
  323. ckucon.c  23 Nov 92    5A(047)    CONNECT command for UNIX
  324. ckufio.c  23 Nov 92    5A(067)    File system interface for UNIX and OS/2
  325. ckutio.c  23 Nov 92    5A(102)    Communications i/o for UNIX
  326. ckuxla.h  27 Jun 92               Character-set symbols for UNIX & others
  327. ckuxla.c  21 Nov 92    5A(018)    Character-set translation for UNIX & others
  328. ckustr.c  11 Sep 92      -        String extraction module for 2.xBSD
  329. cku2tm.c  11 Sep 92      -        ctimed support for 2.10 BSD
  330.  
  331. ckvvms.h   7 Oct 92               VMS- and OpenVMS-specific definitions
  332. ckvcon.c  26 Oct 92    5.0-028    CONNECT command for VMS and OpenVMS
  333. ckvfio.c   5 Nov 92    2.0-095    File system support for VMS and OpenVMS
  334. ckvtio.c  23 Nov 92    2.0-050    Communications i/o for VMS and OpenVMS
  335. ckvioc.h  19 Oct 92      -        VMS ioctl() simulation symbol definitions
  336. ckvioc.c  19 Oct 92      -        VMS ioctl() simulation
  337. ckvcvt.c   6 Sep 92    T1.0-05    VMS labeled-file decoder
  338.  
  339. (End of CKAAAA.HLP)
  340.